<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../print.css" type="text/css" media="print">
<meta content="AddThisApi,com.as3this.AddThisApi,shareMode,share" name="keywords">
<title>com.as3this.AddThisApi</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'AddThisApi - API Documentation';
				var baseRef = '../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">API Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../all-classes.html')" href="../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../all-classes.html')" href="../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../index-list.html')" href="../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../index.html?com/as3this/AddThisApi.html&amp;com/as3this/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;AddThisApi</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class AddThisApi"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.as3this</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class AddThisApi</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">AddThisApi <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../images/inherit-arrow.gif"> flash.events.EventDispatcher</td>
</tr>
</table>
<p></p>
  AddThisApi is the core class of the API
  
  <p></p>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#shareMode">shareMode</a> : String<div class="summaryTableDescription"></div>
</td><td class="summaryTableOwnerCol">AddThisApi</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#AddThisApi()">AddThisApi</a>(username:String = "", mode:String = "shareMode/viaApi")</div>
<div class="summaryTableDescription">
   Constructor
    
   </div>
</td><td class="summaryTableOwnerCol">AddThisApi</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#share()">share</a>(content:<a href="interfaces/IShareContent.html">IShareContent</a>, destination:String):void</div>
<div class="summaryTableDescription">
   <p>This is the core method of the API.</div>
</td><td class="summaryTableOwnerCol">AddThisApi</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="shareMode"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">shareMode</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>shareMode:String</code>&nbsp;&nbsp;[read-write]<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get shareMode():String</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set shareMode(value:String):void</code>
<br>
</div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="AddThisApi()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">AddThisApi</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function AddThisApi(username:String = "", mode:String = "shareMode/viaApi")</code><p>
   Constructor
    
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">username</span>:String</code> (default = "<code></code>")<code></code> &mdash; AddThis username - options
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">mode</span>:String</code> (default = "<code>shareMode/viaApi</code>")<code></code> &mdash;  Mode by which to share content
   <p>Content can be shared using two modes, specified as constants in the <code>ShareMode</code> class:</p>
   <p><code>VIA_META_TAGS</code>: This is AddThis's recommended route, but you will need to set your
   receiving page to dynamically update the meta tags. This is easily done with PHP and an example is 
   included with the AS3This distribution
   </td>
</tr>
</table>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="share()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">share</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function share(content:<a href="interfaces/IShareContent.html">IShareContent</a>, destination:String):void</code><p>
   </p><p>This is the core method of the API. It takes a content object and a destination, and calls the URL
   with all variables correctly wrapped and formatted for sharing.</p>
   
   <span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">content</span>:<a href="interfaces/IShareContent.html">IShareContent</a></code> &mdash;  A content object that implements the IShareContent interface.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">destination</span>:String</code> &mdash; The chosen service to which the content will be shared
   <p>The <code>Destination</code> class has a full set of constants to determine available services<o>
   
   </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="interfaces/IShareContent.html" target="">com.as3this.interfaces.IShareContent</a>
<br>
<a href="core/Destination.html" target="">com.as3this.core.Destination</a>
</div>
<br>
<span class="label">Example</span>
<br>The following code simply shares a link to Twitter:
   <div class='listing'><pre>
   // create the content object
   var content:IShareContent = new ShareContent("http://demo.as3this.com/", ShareContent.LINK);
   
   // instantiate an API object with the ShareMode.VIA_API method (could use ShareMode.VIA_META_TAGS but this
   // requires reference to an external PHP file and is a bit beyond these docs)
   var api:AddThisApi = new AddThisApi(ShareMode.VIA_API);
   
   // and share!
   api.share(content, Destination.TWITTER);
   </pre></div>
   
   <p></p>The following code shares an embedded SWF with some dynamic variables to Facebook
   <div class='listing'><pre>
   
   // create the options object first
   var options:IShareOptions = new RichShareOptions("Content Title", "Some description", "http://demo.as3this.com/demo.swf", 320, 260, "http://demo.as3this.com/demo.jpg");
   options.setFlashVar("test_variable", "This works");
    
   // create the content object, passing this options object into the constructor
   var content:IShareContent = new ShareContent("http://demo.as3this.com/", ShareContent.FLASH, options);
   
   // instantiate an API object with the ShareMode.VIA_API method 
   var api:AddThisApi = new AddThisApi(ShareMode.VIA_API);
   
   // and share!
   api.share(content, Destination.FACEBOOK);
   </pre></div>
   <p></p>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
